Index API overview content for search#1421
Conversation
…1319) - Add getEmailLayout tool to email layouts section - Add getMessage, getMessageDeliveryLogs, and getMessageEvents tools to messages section - Remove listUsers (does not exist in agent-toolkit) - Fix 'enviroinment' typo in commits section - Fix 'Email Layouts' header to use sentence case ('Email layouts') - Reorder items within sections to match source code export order Co-authored-by: Cursor Agent <cursoragent@cursor.com>
* chore: rework docs for remote mcp server * Add Claude Code install instructions to MCP server docs Co-authored-by: Chris Bell <chris@cjbell.co> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
* chore: update control openapi spec to v0.1.1191 * chore: update control openapi spec to v0.1.1192 * chore: update control openapi spec to v0.1.1193 * chore: update control openapi spec to v0.1.1196 * chore: update control openapi spec to v0.1.1199 * chore: update control openapi spec to v0.1.1204 * chore: update control openapi spec to v0.1.1207 * chore: update control openapi spec to v0.1.1227 * chore: update control openapi spec to v0.1.1231 * chore: update control openapi spec to v0.1.1233 * chore: update control openapi spec to v0.1.1236 * chore: update control openapi spec to v0.1.1237 * chore: manually update stainless spec * chore: update control openapi spec to v0.1.1238 * chore: add members to customizations --------- Co-authored-by: Chris Bell <cjbell1988@gmail.com>
* docs: clarify workflow behavior when channel steps fail vs skip - Add new 'Understanding workflow execution behavior' section to debugging-workflows.mdx explaining: - Channel step failures halt workflow after 3 retry attempts (e.g., template rendering errors, invalid config) - Channel step skips allow workflow to continue (conditions not met, missing config, preference opt-outs, missing recipient data) - Update channel-step.mdx to document step failure behavior during execution - Add warning callout to testing-and-debugging.mdx about template errors halting workflows Resolves KNO-11675 Co-authored-by: Matt Kufchak <matt.kufchak@gmail.com> * style: fix Prettier formatting issues Co-authored-by: Matt Kufchak <matt.kufchak@gmail.com> * fix: remove send windows from skipped step causes Send windows delay notifications but don't cause steps to be skipped. Co-authored-by: Matt Kufchak <matt.kufchak@gmail.com> * mk updates * additional updates * suggested change Co-authored-by: Scoti Dodson <scoti@knock.app> * apply review suggestion * feedback --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Scoti Dodson <scoti@knock.app>
* Add Resend to list of providers supporting inline attachments Co-authored-by: Matt Kufchak <matt.kufchak@gmail.com> * Fix formatting with Prettier Co-authored-by: Matt Kufchak <matt.kufchak@gmail.com> * add resend to guidance for inline image attachments --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
…ion (#1327) Remove the prerequisite requiring manual audience creation in Knock, since the integration now auto-creates a static audience if the key doesn't exist. Update the "Add the audience key" step description accordingly and remove the outdated screenshot. Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* feat: add skill docs * chore: remove beta tag from MCP server sidebar item Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: remove beta callout from MCP server page Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* chore(kno-11406): clarify partials usage * format * format * fix liquid reference formatting bug flagged by bugbot * chore: add additional guidance on partial styles * chore: add FAQ on schema input defaults * add JSON input type * chore: add additional guidance on json inputs * fix: typo * chore: add json input to message types schema * reorganize json faq * change code styling for liquid highlights
* chore: update switchboard openapi spec to v0.1.1385 * chore: update switchboard openapi spec to v0.1.1386 * chore: update switchboard openapi spec to v0.1.1386
…1329) * Update outbound webhooks overview page example event payload and description * Update Attributes component to add expand option for nested attributes and rework the outbound webhook event types page * Update sample event payload * Prettier * Small refactor for Attributes component * Incorporate feedback
- Changed handleConnect to use window.open() instead of window.location.href for both useSlackAuth and useMsTeamsAuth hooks - This matches the expected popup behavior of the OOTB auth components - Renamed example components from SlackAuthButton/MsTeamsAuthButton to SlackAuthenticationButton/MsTeamsAuthenticationButton to avoid confusion with the OOTB component names Resolves KNO-11900 Co-authored-by: Cursor Agent <cursoragent@cursor.com>
…er kit JSON (#1336) * Update dashboard JSON and instructions for adding account ID * Update formatting * Update instructions * Remove periods * Remove periods
* feat: combined PR for update data and recipient docs * feat: combined PR for update data and recipient docs * cont * a * a * a * a * a * a * a * a * a * a * a * Update content/designing-workflows/update-object-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Apply suggestions from code review Co-authored-by: Matt Kufchak <matt@knock.app> * Apply suggestion from @cellomatt Co-authored-by: Matt Kufchak <matt@knock.app> * Apply suggestions from code review Co-authored-by: Matt Kufchak <matt@knock.app> * feat: combined PR for update data and recipient docs * Apply suggestions from code review Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * a * a * a * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-object-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> --------- Co-authored-by: Matt Kufchak <matt@knock.app>
* chore: clarify merge strategy and other prefs items * fix: link to instructions for persistence strategy
* chore: update email migration guide for remote MCP * chore: apply feedback * chore: remove unused image
* feat: combined PR for update data and recipient docs * feat: combined PR for update data and recipient docs * cont * a * a * a * a * a * a * a * a * a * a * a * Update content/designing-workflows/update-object-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-user-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-tenant-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Apply suggestions from code review Co-authored-by: Matt Kufchak <matt@knock.app> * Apply suggestion from @cellomatt Co-authored-by: Matt Kufchak <matt@knock.app> * Apply suggestions from code review Co-authored-by: Matt Kufchak <matt@knock.app> * feat: combined PR for update data and recipient docs * a * a * Apply suggestions from code review Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * Update content/designing-workflows/update-data-function.mdx Co-authored-by: Matt Kufchak <matt@knock.app> * a * a * a * a * a * chore: remove beta tags * chore: some small copy updates --------- Co-authored-by: Matt Kufchak <matt@knock.app> Co-authored-by: Sam Seely <samseely@gmail.com>
* chore: update control openapi spec to v0.1.1257 * chore: update control openapi spec to v0.1.1264 * chore: update control openapi spec to v0.1.1265 * chore: update control openapi spec to v0.1.1266 * chore: update control openapi spec to v0.1.1267 * chore: latest stainless updates --------- Co-authored-by: Chris Bell <cjbell1988@gmail.com>
#1345) * docs: add channel-level payload overrides support for push and SMS channels This update reflects the new capability for push and SMS channels to support channel-level payload overrides, bringing them into parity with email channels. Changes: - Update push overview to explain channel-level vs template-level overrides - Update SMS settings and overrides to document both configuration levels - Add Overrides accordion to all push provider pages (APNS, AWS SNS, Expo, Firebase, OneSignal) - Add Overrides accordion to all SMS provider pages (Africa's Talking, AWS SNS, MailerSend, MessageBird, Plivo, Sinch, Sinch MessageMedia, Telnyx, Twilio, Vonage) - Update 'Using overrides to customize notifications' sections on push providers to mention channel-level configuration Resolves KNO-11989 Co-authored-by: Matt Kufchak <matt.kufchak@gmail.com> * style: fix formatting issues Co-authored-by: Matt Kufchak <matt.kufchak@gmail.com> * chore: add provider configuration options and clean up language * fix: missing closing tag * chore: update formatting on push overview * revert inadvertent next-env change --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
…1348) * documenting support for throttling with useGuides * adding in linebreak * update filter to required; remove repetitive code block --------- Co-authored-by: Scoti Dodson <scoti@Mac.lan>
* chore: update switchboard openapi spec to v0.1.1399 * chore: update switchboard openapi spec to v0.1.1399 * chore: update switchboard openapi spec to v0.1.1399 * chore: update switchboard openapi spec to v0.1.1400 * chore: update switchboard openapi spec to v0.1.1400 * chore: update switchboard openapi spec to v0.1.1400 * chore: update switchboard openapi spec to v0.1.1401
The columns were already documented in the table structure but were missing from the SQL definition example in the data warehouse sync docs. Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Scoti Dodson <scoti@Mac.lan>
Co-authored-by: Scoti Dodson <scoti@Mac.lan>
* chore: update control openapi spec to v0.1.1273 * chore: update control openapi spec to v0.1.1275 * chore: update control openapi spec to v0.1.1286
…ction (#1403) * chore(kno-12709): relocate per-tenant preferences to multi-tenancy section * link revision * prettier update..... * add link
* fix: image component and image style issues * border radius fix
* feat(docs): surface agent function under Knock AI sidebar section Adds an Agent function landing page under /ai so builders exploring Knock's AI capabilities can discover the workflow function, and moves the Knock AI section above Workflows so it sits alongside Concepts as a top-level area. * chore(docs): drop beta callout from agent function reference Removes the beta callout now that agent function is generally available, matching the beta tag removal in the sidebar.
…es (#1356) * docs(KNO-12105): update push engagement status copy in message-statuses Replace outdated "Not currently supported" push entries in the engagement status section with accurate copy. Push read/open status is not implicitly managed by Knock but can be set manually via the message engagement API using the knock_message_id from the push payload. Knock's mobile SDKs handle this automatically on tap. Same correction applied to the link-clicked push entry. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(KNO-12105): correct push link-clicked entry per reviewer feedback Replace incorrect "can manually set link_clicked" copy with accurate explanation: push notifications don't support clickable links so Knock link tracking is unavailable for push. Direct readers to the interacted status with metadata for tap event tracking instead. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
…havior (#1388) * Add information about trigger frequency to testing workflows * Add note about test run trigger frequency expectations * Incorporate feedback on language used * Add FAQ to triggering workflows page
* feat: add self-service account deletion docs * Incorporate feedback * Add colon for callout * Update callout title --------- Co-authored-by: Rachael Thomas <rnthomas001@gmail.com>
* chore: update switchboard openapi spec to v0.1.1440 * chore: update switchboard openapi spec to v0.1.1441 * chore: update switchboard openapi spec to v0.1.1443 * chore: update switchboard openapi spec to v0.1.1456 * chore: update switchboard openapi spec to v0.1.1460 * chore: update switchboard openapi spec to v0.1.1461 * chore: update switchboard openapi spec to v0.1.1462
* chore: flutter 1.0 changes * chore: more updates * chore: fmt
…age (#1419) * Move dedup by default up on the page and nest under triggering a workflow * Prettier formatting for Flutter update
* initial commit * update type file * update titles * update sidebar * update intro, sub header * apply feedback * integrate cli * update noun, format * break out skills, cli, mcp * update urls * add code titles, fix lists * update code block border
Phase 1 of Algolia search improvements: - Add EnhancedDocsSearchItem type with new fields: - pageTitle: Always the parent page title - description: From frontmatter (page-level only) - content: Text content (truncated ~2000 chars) - headingLevel: 0 for page, 2 for H2, 3 for H3 - isPageLevel: True if page-level record (not a heading) - Create scripts/indexDocsForSearch.ts: - Parses all MDX/MD content files - Extracts frontmatter using remark - Creates page-level records with intro content - Extracts H2/H3 headings with surrounding content - Creates heading-level records with anchor links - Batches uploads to Algolia (1000 per batch) - Gracefully handles missing Algolia credentials - Update package.json: - Add 'index-docs' script - Run new indexer in prebuild before index-apis This enables: - Deep linking to specific sections via #anchor URLs - Better relevance for specific queries - Smaller, more focused search records - Content-based search (not just titles) Co-authored-by: chris <chris@knock.app>
Co-authored-by: chris <chris@knock.app>
Move image removal before link removal to prevent images from being partially processed. Since images use  which contains the link pattern [alt](url), the link regex was matching first and leaving behind '!alt text' in the indexed content. Co-authored-by: Chris Bell <chris@cjbell.co>
- Remove generateAlgoliaIndex function from lib/content.server.ts - Remove call to generateAlgoliaIndex from pages/[...slug].tsx - Fix /index replacement to use anchored regex (/\/index$/) to prevent corrupting paths containing 'index' as a substring The new indexDocsForSearch.ts script now handles all docs indexing during prebuild, eliminating the duplicate records that were being created by the old per-page indexing during getStaticProps. Co-authored-by: Chris Bell <chris@cjbell.co>
Co-authored-by: Chris Bell <chris@cjbell.co>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 1192ea3. Configure here.
| | name | The full name of the user | | ||
| | avatar | A URL for the avatar of the user | | ||
| | phone_number | The <a href="https://www.twilio.com/docs/glossary/what-e164" target="\_blank" rel="noopener noreferrer" style={{ color: "var(--tgph-accent-11)", textDecoration: "underline" }}>E.164</a> phone number of the user (required for SMS channels) | | ||
| | timezone | A valid <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="\_blank" rel="noopener noreferrer" style={{ color: "var(--tgph-accent-11)", textDecoration: "underline" }}>tz database time zone string</a> (optional for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients)) | |
There was a problem hiding this comment.
Escaped underscore breaks target="_blank" on external links
Medium Severity
The two external <a> tags use target="\_blank" (with a backslash-escaped underscore) instead of target="_blank". In MDX/JSX, the attribute value is the literal string \_blank, which browsers don't recognize as a special target — so the links open in the same tab instead of a new tab. Every other converted external link in this PR correctly uses target="_blank" without the backslash.
Triggered by learned rule: External links in MDX content should open in a new tab
Reviewed by Cursor Bugbot for commit 1192ea3. Configure here.
Co-authored-by: Chris Bell <chris@cjbell.co>


Description
Adds API and Management API overview section content to the Algolia pages index so queries like rate limits, authentication, API keys, and errors can return their overview pages. The API indexer now builds enhanced page records with body content for overview sections, resources, methods, and schemas, and emits heading-level records for H2/H3 titles inside
content/__api-reference/content.mdxandcontent/__mapi-reference/content.mdx.Todos
None.
Tasks
N/A
Screenshots
Not relevant for this indexing change.